home *** CD-ROM | disk | FTP | other *** search
/ The Atari Compendium / The Atari Compendium (Toad Computers) (1994).iso / files / umich / tex / mkind212.zoo / makeindx.1 < prev    next >
Text File  |  1993-05-27  |  36KB  |  830 lines
  1. MAKEINDEX(1L)     MISC. REFERENCE MANUAL PAGES      MAKEINDEX(1L)
  2.  
  3.  
  4.  
  5. NAME
  6.      makeindex - a general purpose,  formatter-independent  index
  7.      processor
  8.  
  9. SYNOPSIS
  10.      makeindex [-c] [-g] [-i] [-l] [-o _✓i_✓n_✓d] [-p  _✓n_✓u_✓m]  [-q]  [-r]
  11.      [-s _✓s_✓f_✓i_✓l_✓e] [-t _✓l_✓o_✓g] [_✓i_✓d_✓x_✓0 _✓i_✓d_✓x_✓1 _✓i_✓d_✓x_✓2...]
  12.  
  13. DESCRIPTION
  14.      The program _✓m_✓a_✓k_✓e_✓i_✓n_✓d_✓e_✓x  is  a  general  purpose  hierarchical
  15.      index  generator;  it accepts one or more input files (often
  16.      produced by a  text  formatter  such  as  TeX  (_✓t_✓e_✓x(1L))  or
  17.      _✓t_✓r_✓o_✓f_✓f(1),  sorts  the  entries,  and produces an output file
  18.      which can be formatted.  The index can have up to three lev-
  19.      els  (0,  1,  and  2)  of subitem nesting.  The way in which
  20.      words are flagged for indexing within the main  document  is
  21.      specific  to the formatter used; _✓m_✓a_✓k_✓e_✓i_✓n_✓d_✓e_✓x does _✓n_✓o_✓t automate
  22.      the process of selecting these words.  As the  output  index
  23.      is  hierarchical,  _✓m_✓a_✓k_✓e_✓i_✓n_✓d_✓e_✓x can be considered complimentary
  24.      to the _✓a_✓w_✓k(1)-based _✓m_✓a_✓k_✓e._✓i_✓n_✓d_✓e_✓x(1L)  system  of  Bentley  and
  25.      Kernighan,  which  is  specific  to _✓t_✓r_✓o_✓f_✓f(1), generates non-
  26.      hierarchical indices, and employs a much simpler syntax  for
  27.      indicating  index  entries.   For  illustration  of use with
  28.      _✓t_✓r_✓o_✓f_✓f and _✓T_✓e_✓X, see the section EXAMPLES below.
  29.  
  30.      The formats of the input and output files are specified in a
  31.      style  file; by default, input is assumed to be a ._✓i_✓d_✓x file,
  32.      as generated by LaTeX.
  33.  
  34.      Unless specified explicitly, the  base  name  of  the  first
  35.      input  file  (_✓i_✓d_✓x_✓0)  is used to determine the names of other
  36.      files.  For each input file name specified, a file  of  that
  37.      name is sought.  If this file is not found and the file name
  38.      has no extension, the extension ._✓i_✓d_✓x  is  appended.   If  no
  39.      file with this name is found, _✓m_✓a_✓k_✓e_✓i_✓n_✓d_✓e_✓x aborts.
  40.  
  41.      If exactly one input file was given and  no  explicit  style
  42.      file  was specified using -s, _✓m_✓a_✓k_✓e_✓i_✓n_✓d_✓e_✓x uses a file with the
  43.      extension ._✓m_✓s_✓t as default style file (when present).
  44.  
  45.      For important notes on how to select index keywords, see the
  46.      document  by Lamport cited below.  As an issue separate from
  47.      selecting index keywords, a systematic mechanism for placing
  48.      index  terms in a document is suggested in _✓I_✓n_✓d_✓e_✓x _✓P_✓r_✓e_✓p_✓a_✓r_✓a_✓t_✓i_✓o_✓n
  49.      _✓a_✓n_✓d _✓P_✓r_✓o_✓c_✓e_✓s_✓s_✓i_✓n_✓g, a paper cited below.
  50.  
  51. OPTIONS
  52.      -c        Compress intermediate blanks (ignoring leading and
  53.                trailing  blanks and tabs).  By default, blanks in
  54.                the index key are retained.
  55.  
  56.      -g        Employ German  word  ordering  in  the  index,  in
  57.                accord  with  rules  set  forth  in  DIN 5007.  By
  58.                default, _✓m_✓a_✓k_✓e_✓i_✓n_✓d_✓e_✓x  employs  a  word  ordering  in
  59.                which  precedence  is: symbols, numbers, uppercase
  60.                letters, lowercase letters.  The sequence in  Ger-
  61.                man  word ordering is: symbols, lowercase letters,
  62.                uppercase letters,  numbers.   Additionally,  this
  63.                option  enables  _✓m_✓a_✓k_✓e_✓i_✓n_✓d_✓e_✓x to recognize the German
  64.                TeX-commands {"a, "o, "u and "s} as  {ae,  oe,  ue
  65.                and  ss}  during  the sorting of the entries.  The
  66.                quote character must be redefined in a style  file
  67.                (for  example,  redefine  quote  as  '+').  If the
  68.                quote character is not redefined,  _✓m_✓a_✓k_✓e_✓i_✓n_✓d_✓e_✓x  will
  69.                produce an error message and abort.
  70.  
  71.      -i        Take input from _✓s_✓t_✓d_✓i_✓n.  When this option is speci-
  72.                fied and -o is not, output is written to _✓s_✓t_✓d_✓o_✓u_✓t.
  73.  
  74.      -l        Letter ordering; by default, word ordering is used
  75.                (see the ORDERING section).
  76.  
  77.      -o _✓i_✓n_✓d    Employ _✓i_✓n_✓d as the output index file.  By  default,
  78.                the  file  name is created by appending the exten-
  79.                sion ._✓i_✓n_✓d to the base name of the first input file
  80.                (_✓i_✓d_✓x_✓0).
  81.  
  82.      -p _✓n_✓u_✓m    Set the starting page number of the  output  index
  83.                file  to  be _✓n_✓u_✓m (useful when the index file is to
  84.                be formatted separately).  The argument _✓n_✓u_✓m may be
  85.                numerical or one of the following:
  86.  
  87.                _✓a_✓n_✓y       The starting page  is  the  last  source
  88.                          page number plus 1.
  89.  
  90.                _✓o_✓d_✓d       The starting page is the first odd  page
  91.                          following the last source page number.
  92.  
  93.                _✓e_✓v_✓e_✓n      The starting page is the first even page
  94.                          following the last source page number.
  95.  
  96.                The last source  page  is  obtained  by  searching
  97.                backward in the log file for the first instance of
  98.                a number included within  paired  square  brackets
  99.                ([...]).   If  a page number is missing or the log
  100.                file is not found, no attempt will be made to  set
  101.                the  starting  page  number.   The source log file
  102.                name is determined by appending the extension ._✓l_✓o_✓g
  103.                to the base name of the first input file (_✓i_✓d_✓x_✓0).
  104.  
  105.      -q        Quiet  mode;  send  no  messages  to  _✓s_✓t_✓d_✓e_✓r_✓r.   By
  106.                default,  progress  and error messages are sent to
  107.                _✓s_✓t_✓d_✓e_✓r_✓r as well as to the transcript file.
  108.  
  109.      -r        Disable implicit page range formation; page ranges
  110.                must be created by using explicit range operators;
  111.                see SPECIAL EFFECTS below.  By default,  three  or
  112.                more  successive  pages are automatically abbrevi-
  113.                ated as a range (e.g. 1-5).
  114.  
  115.      -s sty    Employ _✓s_✓t_✓y as the style file  (no  default).   The
  116.                environment  variable  INDEXSTYLE defines the path
  117.                where the style file should be found.
  118.  
  119.      -t log    Employ _✓l_✓o_✓g as the transcript  file.   By  default,
  120.                the  file  name is created by appending the exten-
  121.                sion ._✓i_✓l_✓g to the base name of the first input file
  122.                (_✓i_✓d_✓x_✓0).
  123.  
  124. STYLE FILE
  125.      The style file informs _✓m_✓a_✓k_✓e_✓i_✓n_✓d_✓e_✓x about  the  format  of  the
  126.      ._✓i_✓d_✓x input files and the intended format of the final output
  127.      file; examples appear below.  This file can reside  anywhere
  128.      in  the path defined by the environment variable INDEXSTYLE.
  129.      The style file contains a  list  of  <_✓s_✓p_✓e_✓c_✓i_✓f_✓i_✓e_✓r,  _✓a_✓t_✓t_✓r_✓i_✓b_✓u_✓t_✓e>
  130.      pairs.  There are two types of specifiers: input and output.
  131.      Pairs do not have to appear in any particular order.  A line
  132.      begun by `%' is a comment.  In the following list of specif-
  133.      iers and arguments, <string> is an arbitrary  string  delim-
  134.      ited  by  double  quotes  ("..."), <char> is a single letter
  135.      embraced by single quotes ('...'), and <number> is a  nonne-
  136.      gative  integer.   The maximum length of a <string> is 2048.
  137.      A  literal  backslash  or  quote  must  be  escaped  (by   a
  138.      backslash).   Anything  not specified in the style file will
  139.      be assigned a default value, which is shown at the  head  of
  140.      the rightmost column.
  141.  
  142.   INPUT STYLE SPECIFIERS
  143.      actual <char>            '@'
  144.                               Symbol  indicating  that  the  next
  145.                               entry  is  to  appear in the output
  146.                               file.
  147.  
  148.      arg_close <char>         '}'
  149.                               Closing  delimiter  for  the  index
  150.                               entry argument.
  151.  
  152.      arg_open <char>          '{'
  153.                               Opening  delimiter  for  the  index
  154.                               entry argument.
  155.  
  156.